home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / AllPlanes.z / AllPlanes
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))     AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           AllPlanes, BlackPixel, WhitePixel, ConnectionNumber,
  10.           DefaultColormap, DefaultDepth, XListDepths, DefaultGC,
  11.           DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen,
  12.           DefaultVisual, DisplayCells, DisplayPlanes, DisplayString,
  13.           XMaxRequestSize, XExtendedMaxRequestSize,
  14.           LastKnownRequestProcessed, NextRequest, ProtocolVersion,
  15.           ProtocolRevision, QLength, RootWindow, ScreenCount,
  16.           ScreenOfDisplay, ServerVendor, VendorRelease - Display
  17.           macros and functions
  18.  
  19.      SSSSYYYYNNNNTTTTAAAAXXXX
  20.           AllPlanes
  21.  
  22.           BlackPixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  23.  
  24.           WhitePixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  25.  
  26.           ConnectionNumber(_d_i_s_p_l_a_y)
  27.  
  28.           DefaultColormap(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  29.  
  30.           DefaultDepth(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  31.  
  32.           int *XListDepths(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r, _c_o_u_n_t__r_e_t_u_r_n)
  33.                 Display *_d_i_s_p_l_a_y;
  34.                 int _s_c_r_e_e_n__n_u_m_b_e_r;
  35.                 int *_c_o_u_n_t__r_e_t_u_r_n;
  36.  
  37.           DefaultGC(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  38.  
  39.           DefaultRootWindow(_d_i_s_p_l_a_y)
  40.  
  41.           DefaultScreenOfDisplay(_d_i_s_p_l_a_y)
  42.  
  43.           DefaultScreen(_d_i_s_p_l_a_y)
  44.  
  45.           DefaultVisual(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  46.  
  47.           DisplayCells(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  48.  
  49.           DisplayPlanes(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  50.  
  51.           DisplayString(_d_i_s_p_l_a_y)
  52.  
  53.           long XMaxRequestSize(_d_i_s_p_l_a_y)      Display *_d_i_s_p_l_a_y;
  54.  
  55.           long XExtendedMaxRequestSize(_d_i_s_p_l_a_y)      Display *_d_i_s_p_l_a_y;
  56.  
  57.           LastKnownRequestProcessed(_d_i_s_p_l_a_y)
  58.  
  59.           NextRequest(_d_i_s_p_l_a_y)
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))     AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           ProtocolVersion(_d_i_s_p_l_a_y)
  75.  
  76.           ProtocolRevision(_d_i_s_p_l_a_y)
  77.  
  78.           QLength(_d_i_s_p_l_a_y)
  79.  
  80.           RootWindow(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  81.  
  82.           ScreenCount(_d_i_s_p_l_a_y)
  83.  
  84.           ScreenOfDisplay(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  85.  
  86.           ServerVendor(_d_i_s_p_l_a_y)
  87.  
  88.           VendorRelease(_d_i_s_p_l_a_y)
  89.  
  90.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  91.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  92.  
  93.           _s_c_r_e_e_n__n_u_m_b_e_r
  94.                     Specifies the appropriate screen number on the
  95.                     host server.
  96.  
  97.           _c_o_u_n_t__r_e_t_u_r_n
  98.                     Returns the number of depths.
  99.  
  100.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  101.           The _A_l_l_P_l_a_n_e_s macro returns a value with all bits set to 1
  102.           suitable for use in a plane argument to a procedure.
  103.  
  104.           The _B_l_a_c_k_P_i_x_e_l macro returns the black pixel value for the
  105.           specified screen.
  106.  
  107.           The _W_h_i_t_e_P_i_x_e_l macro returns the white pixel value for the
  108.           specified screen.
  109.  
  110.           The _C_o_n_n_e_c_t_i_o_n_N_u_m_b_e_r macro returns a connection number for
  111.           the specified display.
  112.  
  113.           The _D_e_f_a_u_l_t_C_o_l_o_r_m_a_p macro returns the default colormap ID
  114.           for allocation on the specified screen.
  115.  
  116.           The _D_e_f_a_u_l_t_D_e_p_t_h macro returns the depth (number of planes)
  117.           of the default root window for the specified screen.
  118.  
  119.           The _X_L_i_s_t_D_e_p_t_h_s function returns the array of depths that
  120.           are available on the specified screen.  If the specified
  121.           screen_number is valid and sufficient memory for the array
  122.           can be allocated, _X_L_i_s_t_D_e_p_t_h_s sets count_return to the
  123.           number of available depths.  Otherwise, it does not set
  124.           count_return and returns NULL.  To release the memory
  125.           allocated for the array of depths, use _X_F_r_e_e.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))     AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           The _D_e_f_a_u_l_t_G_C macro returns the default GC for the root
  141.           window of the specified screen.
  142.  
  143.           The _D_e_f_a_u_l_t_R_o_o_t_W_i_n_d_o_w macro returns the root window for the
  144.           default screen.
  145.  
  146.           The _D_e_f_a_u_l_t_S_c_r_e_e_n_O_f_D_i_s_p_l_a_y macro returns the default screen
  147.           of the specified display.
  148.  
  149.           The _D_e_f_a_u_l_t_S_c_r_e_e_n macro returns the default screen number
  150.           referenced in the _X_O_p_e_n_D_i_s_p_l_a_y routine.
  151.  
  152.           The _D_e_f_a_u_l_t_V_i_s_u_a_l macro returns the default visual type for
  153.           the specified screen.
  154.  
  155.           The _D_i_s_p_l_a_y_C_e_l_l_s macro returns the number of entries in the
  156.           default colormap.
  157.  
  158.           The _D_i_s_p_l_a_y_P_l_a_n_e_s macro returns the depth of the root window
  159.           of the specified screen.
  160.  
  161.           The _D_i_s_p_l_a_y_S_t_r_i_n_g macro returns the string that was passed
  162.           to _X_O_p_e_n_D_i_s_p_l_a_y when the current display was opened.
  163.  
  164.           The _X_M_a_x_R_e_q_u_e_s_t_S_i_z_e function returns the maximum request
  165.           size (in 4-byte units) supported by the server without using
  166.           an extended-length protocol encoding.  Single protocol
  167.           requests to the server can be no larger than this size
  168.           unless an extended-length protocol encoding is supported by
  169.           the server.  The protocol guarantees the size to be no
  170.           smaller than 4096 units (16384 bytes).  Xlib automatically
  171.           breaks data up into multiple protocol requests as necessary
  172.           for the following functions:  _X_D_r_a_w_P_o_i_n_t_s, _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s,
  173.           _X_D_r_a_w_S_e_g_m_e_n_t_s, _X_F_i_l_l_A_r_c_s, _X_F_i_l_l_R_e_c_t_a_n_g_l_e_s, and _X_P_u_t_I_m_a_g_e.
  174.  
  175.           The _X_E_x_t_e_n_d_e_d_M_a_x_R_e_q_u_e_s_t_S_i_z_e function returns zero if the
  176.           specified display does not support an extended-length
  177.           protocol encoding; otherwise, it returns the maximum request
  178.           size (in 4-byte units) supported by the server using the
  179.           extended-length encoding.  The Xlib functions _X_D_r_a_w_L_i_n_e_s,
  180.           _X_D_r_a_w_A_r_c_s, _X_F_i_l_l_P_o_l_y_g_o_n, _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y,
  181.           _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s, and _X_S_e_t_R_e_g_i_o_n will use the extended-
  182.           length encoding as necessary, if supported by the server.
  183.           Use of the extended-length encoding in other Xlib functions
  184.           (for example, _X_D_r_a_w_P_o_i_n_t_s, _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s, _X_D_r_a_w_S_e_g_m_e_n_t_s,
  185.           _X_F_i_l_l_A_r_c_s, _X_F_i_l_l_R_e_c_t_a_n_g_l_e_s, _X_P_u_t_I_m_a_g_e) is permitted but not
  186.           required; an Xlib implementation may choose to split the
  187.           data across multiple smaller requests instead.
  188.  
  189.           The _L_a_s_t_K_n_o_w_n_R_e_q_u_e_s_t_P_r_o_c_e_s_s_e_d macro extracts the full serial
  190.           number of the last request known by Xlib to have been
  191.           processed by the X server.
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))     AAAAllllllllPPPPllllaaaannnneeeessss((((3333XXXX11111111))))
  203.  
  204.  
  205.  
  206.           The _N_e_x_t_R_e_q_u_e_s_t macro extracts the full serial number that
  207.           is to be used for the next request.
  208.  
  209.           The _P_r_o_t_o_c_o_l_V_e_r_s_i_o_n macro returns the major version number
  210.           (11) of the X protocol associated with the connected
  211.           display.
  212.  
  213.           The _P_r_o_t_o_c_o_l_R_e_v_i_s_i_o_n macro returns the minor protocol
  214.           revision number of the X server.
  215.  
  216.           The _Q_L_e_n_g_t_h macro returns the length of the event queue for
  217.           the connected display.
  218.  
  219.           The _R_o_o_t_W_i_n_d_o_w macro returns the root window.
  220.  
  221.           The _S_c_r_e_e_n_C_o_u_n_t macro returns the number of available
  222.           screens.
  223.  
  224.           The _S_c_r_e_e_n_O_f_D_i_s_p_l_a_y macro returns a pointer to the screen of
  225.           the specified display.
  226.  
  227.           The _S_e_r_v_e_r_V_e_n_d_o_r macro returns a pointer to a null-
  228.           terminated string that provides some identification of the
  229.           owner of the X server implementation.
  230.  
  231.           The _V_e_n_d_o_r_R_e_l_e_a_s_e macro returns a number related to a
  232.           vendor's release of the X server.
  233.  
  234.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  235.           BlackPixelOfScreen(3X11), ImageByteOrder(3X11),
  236.           IsCursorKey(3X11), XOpenDisplay(3X11)
  237.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.